TopoStats 2023 Showcase
Laura Wiggins, Sylvia Whittle
What is TopoStats?
- Automated software for processing Atomic Force Microscopy images
- Takes in data, produces pretty pictures and useful stats
How we approach Open Research with TopoStats
Ease of installation
Co-working procedures
- Use of GitHub
- GitHub Issues
- Github Discussion Board
Documentation & Ease of use
- Automatic publishing to ORDA
- Automatic API documentation
- Easy to use config files
- Jupyter Notebooks
- Running courses & workshops
Ease of development
- Python PEP-8
- Auto-formatting with Black
- Linting via Pylint & Flake8
- Pre-commit to ensure adherence
- Pre-commit CI on GitHub
- Comprehensive testing
- Constant refactoring & organisation
FAIR4RS
All these actions have helped us to adhere to the FAIR4RS principles and helped us manage a large software project with a small team.
- Findable
- Accessible
- Interoperable
- Reusable